package com.sky.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;

/**
 * DTO，即数据传输对象（Data Transfer Object），是一种设计模式;(也可以理解为是一种实体,只是专注于数据传输的)
 * DTO通常用于服务层与客户端之间传输数据，简化复杂对象的数据传输，通过只包含必要的字段来减少数据传输量
 * EmployeeLoginDTO类就是一个DTO，用于在员工登录时传递用户名和密码数据。
 *      这样，当后端接收到登录请求时，可以从请求体中解析出这些数据，进而进行验证等后续操作
 */
@Data
@ApiModel(description = "员工登录时传递的数据模型")
//这个是swagger的注解,用于生成api文档,作用在类上,后面描述信息,表示对当前这个类的描述(生成的api文档就会携带这个描述信息)
    //忘记了,可以看"day01_5.3 常用注解"的笔记
public class EmployeeLoginDTO implements Serializable {
/**
 * @ApiModel(description = "员工登录时传递的数据模型")注解用于为EmployeeLoginDTO类生成API文档时提供一个描述，
 * 说明这个类是用于员工登录时传递的数据模型。这样，当使用Swagger生成API文档时，
 * 这个类的描述会出现在文档中，帮助开发者或使用者理解这个类的用途和包含的属性。
 */

    @ApiModelProperty("用户名")  //这个注解,是对属性进行描述(也是swagger的,用来生成api文档的)
    private String username;

    @ApiModelProperty("密码")
    private String password;

}
